home *** CD-ROM | disk | FTP | other *** search
/ Zoom 2 / Zoom - Release 2 (1996)(Active Software)[!].iso / utilities / misc / amigancp / developer / autodocs / amigancp.doc
Text File  |  1995-02-24  |  22KB  |  963 lines
  1. TABLE OF CONTENTS
  2.  
  3. amigancp.library/--pools--
  4. amigancp.library/NCP_AbortRead
  5. amigancp.library/NCP_AbortWrite
  6. amigancp.library/NCP_BeginRead
  7. amigancp.library/NCP_BeginWrite
  8. amigancp.library/NCP_CheckRead
  9. amigancp.library/NCP_CheckWrite
  10. amigancp.library/NCP_clnl
  11. amigancp.library/NCP_CloseChannel
  12. amigancp.library/NCP_Fault
  13. amigancp.library/NCP_ibm2iso
  14. amigancp.library/NCP_ILONG
  15. amigancp.library/NCP_ILONGP
  16. amigancp.library/NCP_ILONGPI
  17. amigancp.library/NCP_iso2ibm
  18. amigancp.library/NCP_IWORD
  19. amigancp.library/NCP_IWORDP
  20. amigancp.library/NCP_IWORDPI
  21. amigancp.library/NCP_LinkRemoteRun
  22. amigancp.library/NCP_OpenChannel
  23. amigancp.library/NCP_Read
  24. amigancp.library/NCP_ReadSig
  25. amigancp.library/NCP_tab_ibm2iso
  26. amigancp.library/NCP_tab_iso2ibm
  27. amigancp.library/NCP_WaitRead
  28. amigancp.library/NCP_WaitWrite
  29. amigancp.library/NCP_Write
  30. amigancp.library/NCP_WriteSig
  31. amigancp.library/--pools--                         amigancp.library/--pools--
  32.  
  33.   The amigancp.library contains a clone set of the
  34.   standard AmigaOS memory pool functions to ensure
  35.   compatibility with OS 2.x systems. The exec pool
  36.   functions were seriously broken in the 2.x releases
  37.   of AmigaOS.
  38.  
  39.    NCP_CreatePool()
  40.    NCP_DeletePool()
  41.    NCP_AllocPooled()
  42.    NCP_FreePooled()
  43.  
  44.   See the exec.library documentation for more
  45.   information about these functions.
  46.  
  47. amigancp.library/NCP_AbortRead                 amigancp.library/NCP_AbortRead
  48.  
  49.    NAME
  50.     NCP_AbortRead -- abort read currently in progress
  51.  
  52.    SYNOPSIS
  53.     NCP_AbortRead( channel )
  54.                      A0 
  55.  
  56.     void NCP_AbortRead( APTR )
  57.  
  58.    FUNCTION
  59.     Aborts the current read request on the given NCP channel.
  60.     Does nothing if no read is pending.
  61.     
  62.    INPUTS
  63.     channel -- a NCP channel created by NCP_OpenChannel()
  64.  
  65.    RESULT
  66.     None.
  67.  
  68.    EXAMPLE
  69.  
  70.    NOTES
  71.     Never forget to finish a read request using NCP_WaitRead(),
  72.     or you'll end up in OS hell.
  73.  
  74.    BUGS
  75.     None known.
  76.  
  77.    SEE ALSO
  78.     NCP_Read(), NCP_WaitRead(), NCP_CheckRead(), NCP_BeginRead()
  79.  
  80. amigancp.library/NCP_AbortWrite               amigancp.library/NCP_AbortWrite
  81.  
  82.    NAME
  83.     NCP_AbortWrite -- abort write currently in progress
  84.  
  85.    SYNOPSIS
  86.     NCP_AbortWrite( channel )
  87.                      A0 
  88.  
  89.     void NCP_AbortWrite( APTR )
  90.  
  91.    FUNCTION
  92.     Aborts the current write request on the given NCP channel.
  93.     Does nothing if no write is pending.
  94.     
  95.    INPUTS
  96.     channel -- a NCP channel created by NCP_OpenChannel()
  97.  
  98.    RESULT
  99.     None.
  100.  
  101.    EXAMPLE
  102.  
  103.    NOTES
  104.     Never forget to finish a write request using NCP_WaitWrite(),
  105.     or you'll end up in OS hell.
  106.  
  107.    BUGS
  108.     None known.
  109.  
  110.    SEE ALSO
  111.     NCP_Write(), NCP_WaitWrite(), NCP_CheckWrite(), NCP_BeginWrite()
  112.  
  113. amigancp.library/NCP_BeginRead                 amigancp.library/NCP_BeginRead
  114.  
  115.    NAME
  116.     NCP_BeginRead -- start a read request on the NCP channel.
  117.  
  118.    SYNOPSIS
  119.     error = NCP_BeginRead( channel, data, datasize )
  120.       D0                     A0      A1       D0
  121.  
  122.     LONG NCP_BeginRead( APTR, APTR, ULON G);
  123.  
  124.    FUNCTION
  125.     Queues a read operation on the current NCP channel.
  126.    
  127.    INPUTS
  128.     channel -- a NCP channel created by NCP_OpenChannel()
  129.     data -- receive buffer
  130.     datasize -- receive buffer size
  131.  
  132.    RESULT
  133.     error -- either 0 if the read was queued successfully
  134.              or a negative error number
  135.  
  136.    EXAMPLE
  137.  
  138.    NOTES
  139.     Only one read request may be queued at a time on a single
  140.     channel. This function fails with NCPE_INUSE if there is
  141.     already a read request outstanding.
  142.  
  143.    BUGS
  144.     None known.
  145.  
  146.    SEE ALSO
  147.     NCP_Read(), NCP_WaitRead(), NCP_AbortRead(), NCP_CheckRead()
  148.  
  149. amigancp.library/NCP_BeginWrite               amigancp.library/NCP_BeginWrite
  150.  
  151.    NAME
  152.     NCP_BeginWrite -- start a write request on the NCP channel.
  153.  
  154.    SYNOPSIS
  155.     error = NCP_BeginWrite( channel, data, datasize )
  156.       D0                     A0      A1       D0
  157.  
  158.     LONG NCP_BeginWrite( APTR, APTR, ULON G);
  159.  
  160.    FUNCTION
  161.     Queues a write operation on the current NCP channel.
  162.    
  163.    INPUTS
  164.     channel -- a NCP channel created by NCP_OpenChannel()
  165.     data -- data buffer
  166.     datasize -- data buffer size
  167.  
  168.    RESULT
  169.     error -- either 0 if the write was queued successfully
  170.              or a negative error number
  171.  
  172.    EXAMPLE
  173.  
  174.    NOTES
  175.     Only one write request may be queued at a time on a single
  176.     channel. This function fails with NCPE_INUSE if there is
  177.     already a write request outstanding.
  178.  
  179.    BUGS
  180.     None known.
  181.  
  182.    SEE ALSO
  183.     NCP_Write(), NCP_WaitWrite(), NCP_AbortWrite(), NCP_CheckWrite()
  184.  
  185. amigancp.library/NCP_CheckRead                 amigancp.library/NCP_CheckRead
  186.  
  187.    NAME
  188.     NCP_CheckRead -- check if a read request is still pending
  189.  
  190.    SYNOPSIS
  191.     status = NCP_CheckRead( channel )
  192.       D0                       A0 
  193.  
  194.     LONG NCP_CheckRead( APTR )
  195.  
  196.    FUNCTION
  197.     Check if a read request is still pending on the given NCP
  198.     channel.
  199.    
  200.    INPUTS
  201.     channel -- a NCP channel created by NCP_OpenChannel()
  202.  
  203.    RESULT
  204.     status -- FALSE if a read is currently pending,
  205.               TRUE if no request is pending or the current
  206.               request has completed.
  207.  
  208.    EXAMPLE
  209.  
  210.    NOTES
  211.     Never forget to finish a read request using NCP_WaitRead(),
  212.     or you'll end up in OS hell.
  213.  
  214.    BUGS
  215.     None known.
  216.  
  217.    SEE ALSO
  218.     NCP_Read(), NCP_WaitRead(), NCP_AbortRead(), NCP_BeginRead()
  219.  
  220. amigancp.library/NCP_CheckWrite               amigancp.library/NCP_CheckWrite
  221.  
  222.    NAME
  223.     NCP_CheckWrite -- check if a write request is still pending
  224.  
  225.    SYNOPSIS
  226.     status = NCP_CheckWrite( channel )
  227.       D0                       A0 
  228.  
  229.     LONG NCP_CheckWrite( APTR )
  230.  
  231.    FUNCTION
  232.     Check if a write request is still pending on the given NCP
  233.     channel.
  234.    
  235.    INPUTS
  236.     channel -- a NCP channel created by NCP_OpenChannel()
  237.  
  238.    RESULT
  239.     status -- FALSE if a write is currently pending,
  240.               TRUE if no request is pending or the current
  241.               request has completed.
  242.  
  243.    EXAMPLE
  244.  
  245.    NOTES
  246.     Never forget to finish a write request using NCP_WaitWrite(),
  247.     or you'll end up in OS hell.
  248.  
  249.    BUGS
  250.     None known.
  251.  
  252.    SEE ALSO
  253.     NCP_Write(), NCP_WaitWrite(), NCP_AbortWrite(), NCP_BeginWrite()
  254.  
  255. amigancp.library/NCP_clnl                           amigancp.library/NCP_clnl
  256.  
  257.    NAME
  258.     NCP_clnl -- clear CR/LF at end of line.
  259.  
  260.    SYNOPSIS
  261.     NCP_clnl( string )
  262.               A0
  263.  
  264.     void NCP_clnl( STRPTR );
  265.  
  266.    FUNCTION
  267.     Clears any CR or LF characters at the end of the string.
  268.  
  269.    INPUTS
  270.     string -- pointer to string (contents will be modified)
  271.  
  272.    RESULT
  273.     None.
  274.  
  275.    EXAMPLE
  276.  
  277.    NOTES
  278.  
  279.    BUGS
  280.     None known.
  281.  
  282.    SEE ALSO
  283.  
  284. amigancp.library/NCP_CloseChannel           amigancp.library/NCP_CloseChannel
  285.  
  286.    NAME
  287.     NCP_CloseChannel -- close a NCP channel
  288.  
  289.    SYNOPSIS
  290.     NCP_CloseChannel( channel )
  291.                        A0      
  292.  
  293.    void NCP_CloseChannel( APTR );
  294.  
  295.    FUNCTION
  296.     Close a NCP channel previously opened by NCP_OpenChannel().
  297.     If this is an active link to the remote machine, it will be
  298.     closed.
  299.  
  300.    INPUTS
  301.     channel -- channel to close. May be NULL, in which case
  302.                this functions does nothing.
  303.  
  304.    RESULT
  305.     None.
  306.  
  307.    EXAMPLE
  308.  
  309.    NOTES
  310.     An active NCP connection will be dropped about 10s
  311.     after the last channel has been closed.
  312.  
  313.    BUGS
  314.     None known.
  315.  
  316.    SEE ALSO
  317.     NCP_OpenChannel()
  318.  
  319. amigancp.library/NCP_Fault                         amigancp.library/NCP_Fault
  320.  
  321.    NAME
  322.    NCP_Fault -- return localized NCP error string
  323.  
  324.    SYNOPSIS
  325.    NCP_Fault( code, header, buffer, buffersize );
  326.                D0     A0      A1        D1
  327.  
  328.    void NCP_Fault( LONG, STRPTR, STRPTR, ULONG );
  329.  
  330.    FUNCTION
  331.    Returns a localized text string associated with the
  332.    error code.
  333.  
  334.    INPUTS
  335.    code -- NCP error code
  336.    header -- header to insert before string. May be NULL
  337.    buffer -- buffer to write the error text to
  338.    buffersize -- size of buffer
  339.  
  340.    RESULT
  341.    None.
  342.  
  343.    EXAMPLE
  344.  
  345.    NOTES
  346.  
  347.    BUGS
  348.    None known.
  349.  
  350.    SEE ALSO
  351.    dos.library/Fault()
  352.  
  353. amigancp.library/NCP_ibm2iso                     amigancp.library/NCP_ibm2iso
  354.  
  355.    NAME
  356.     NCP_ibm2iso -- convert IBM to ISO charachter
  357.  
  358.    SYNOPSIS
  359.     isochar = NCP_ibm2iso( ibmchar )
  360.       D0                    D0 0:7
  361.  
  362.     UBYTE NCP_ibm2iso( UBYTE );
  363.  
  364.    FUNCTION
  365.     Converts a character from the IBM to the ISO charset.
  366.  
  367.    INPUTS
  368.     ibmchar -- character of the IBM codeset
  369.  
  370.    RESULT
  371.     isochar -- equivalent character in the ISO codeset
  372.  
  373.    EXAMPLE
  374.  
  375.    NOTES
  376.  
  377.    BUGS
  378.     None known.
  379.  
  380.    SEE ALSO
  381.  
  382. amigancp.library/NCP_ILONG                         amigancp.library/NCP_ILONG
  383.  
  384.    NAME
  385.     NCP_ILONG -- swap bytes in longword
  386.  
  387.    SYNOPSIS
  388.     slongword = NCP_ILONG( longword )
  389.       D0                     D0
  390.  
  391.     ULONG NCP_ILONG( ULONG );
  392.  
  393.    FUNCTION
  394.     Swaps the byte order within the longword.
  395.  
  396.    INPUTS
  397.     longword -- a 32 bit data word.
  398.  
  399.    RESULT
  400.     slongword -- the same word with the byte order swapped.
  401.  
  402.    EXAMPLE
  403.  
  404.    NOTES
  405.  
  406.    BUGS
  407.     None known.
  408.  
  409.    SEE ALSO
  410.  
  411. amigancp.library/NCP_ILONGP                       amigancp.library/NCP_ILONGP
  412.  
  413.    NAME
  414.     NCP_ILONGP -- swap bytes in longword (pointer version)
  415.  
  416.    SYNOPSIS
  417.     sword = NCP_ILONGP( longwordp1, longwordp2 )
  418.       D0                    A0          A1
  419.  
  420.     ULONG NCP_ILONGP( ULONG *, ULONG * );
  421.  
  422.    FUNCTION
  423.     Swaps the byte order from the longword pointed to by longwordp1
  424.     and places the result in the longword pointed to by longwordp2.
  425.  
  426.    INPUTS
  427.     longwordp1 -- pointer to source longword
  428.     longwordp2 -- pointer to destination longword
  429.  
  430.    RESULT
  431.     sword -- the same word with the byte order swapped.
  432.  
  433.    EXAMPLE
  434.  
  435.    NOTES
  436.     The longwords don't need to be word aligned.
  437.  
  438.    BUGS
  439.     The 68020++ version of amigancp.library requires the hardware
  440.     to be able to do misaligned word accesses. Some early
  441.     accelerator boards may have problems doing this.
  442.  
  443.    SEE ALSO
  444.  
  445. amigancp.library/NCP_ILONGPI                     amigancp.library/NCP_ILONGPI
  446.  
  447.    NAME
  448.     NCP_ILONGPI -- swap bytes in longword (in-place pointer version)
  449.  
  450.    SYNOPSIS
  451.     sword = NCP_ILONGPI( longwordp )
  452.       D0                    A0
  453.  
  454.     ULONG NCP_ILONGP( ULONG * )
  455.  
  456.    FUNCTION
  457.     Swaps the byte order within the longword pointed to by longwordp.
  458.  
  459.    INPUTS
  460.     longwordp -- pointer to longword to swap
  461.  
  462.    RESULT
  463.     sword -- the same word with the byte order swapped.
  464.  
  465.    EXAMPLE
  466.  
  467.    NOTES
  468.     The longword doesn't need to be word aligned.
  469.  
  470.    BUGS
  471.     The 68020++ version of amigancp.library requires the hardware
  472.     to be able to do misaligned word accesses. Some early
  473.     accelerator boards may have problems doing this.
  474.  
  475.    SEE ALSO
  476.  
  477. amigancp.library/NCP_iso2ibm                     amigancp.library/NCP_iso2ibm
  478.  
  479.    NAME
  480.     NCP_iso2ibm -- convert IBM to ISO charachter
  481.  
  482.    SYNOPSIS
  483.     ibmchar = NCP_iso2ibm( isochar )
  484.       D0                    D0 0:7
  485.  
  486.     UBYTE NCP_iso2ibm( UBYTE );
  487.  
  488.    FUNCTION
  489.     Converts a character from the ISO to the IBM charset.
  490.  
  491.    INPUTS
  492.     isochar -- character of the ISO codeset
  493.  
  494.    RESULT
  495.     ibmchar -- equivalent character in the IBM codeset
  496.  
  497.    EXAMPLE
  498.  
  499.    NOTES
  500.  
  501.    BUGS
  502.     None known.
  503.  
  504.    SEE ALSO
  505.  
  506. amigancp.library/NCP_IWORD                         amigancp.library/NCP_IWORD
  507.  
  508.    NAME
  509.     NCP_IWORD -- swap bytes in word
  510.  
  511.    SYNOPSIS
  512.     sword = NCP_IWORD( word )
  513.       D0                D0
  514.  
  515.     UWORD NCP_IWORD( UWORD );
  516.  
  517.    FUNCTION
  518.     Swaps the byte order within the word.
  519.  
  520.    INPUTS
  521.     word -- a 16 bit data word.
  522.  
  523.    RESULT
  524.     sword -- the same word with the byte order swapped.
  525.  
  526.    EXAMPLE
  527.  
  528.    NOTES
  529.  
  530.    BUGS
  531.     None known.
  532.  
  533.    SEE ALSO
  534.  
  535. amigancp.library/NCP_IWORDP                       amigancp.library/NCP_IWORDP
  536.  
  537.    NAME
  538.     NCP_IWORDP -- swap bytes in word (pointer version)
  539.  
  540.    SYNOPSIS
  541.     sword = NCP_IWORDP( wordp1, wordp2 )
  542.       D0                  A0      A1
  543.  
  544.     UWORD NCP_IWORDP( UWORD *, UWORD * );
  545.  
  546.    FUNCTION
  547.     Swaps the byte order from the word pointed to by wordp1
  548.     and places the result in the word pointed to by wordp2.
  549.  
  550.    INPUTS
  551.     wordp1 -- pointer to source word
  552.     wordp2 -- pointer to destination word
  553.  
  554.    RESULT
  555.     sword -- the same word with the byte order swapped.
  556.  
  557.    EXAMPLE
  558.  
  559.    NOTES
  560.     The words don't need to be word aligned.
  561.  
  562.    BUGS
  563.     The 68020++ version of amigancp.library requires the hardware
  564.     to be able to do misaligned word accesses. Some early
  565.     accelerator boards may have problems doing this.
  566.  
  567.    SEE ALSO
  568.  
  569. amigancp.library/NCP_IWORDPI                     amigancp.library/NCP_IWORDPI
  570.  
  571.    NAME
  572.     NCP_IWORDPI -- swap bytes in word (in-place pointer version)
  573.  
  574.    SYNOPSIS
  575.     sword = NCP_IWORDPI( wordp1 )
  576.       D0                   A0
  577.  
  578.     UWORD NCP_IWORDP( UWORD * )
  579.  
  580.    FUNCTION
  581.     Swaps the byte order within the word pointed to by wordp.
  582.  
  583.    INPUTS
  584.     wordp -- pointer to word to swap
  585.  
  586.    RESULT
  587.     sword -- the same word with the byte order swapped.
  588.  
  589.    EXAMPLE
  590.  
  591.    NOTES
  592.     The word doesn't need to be word aligned.
  593.  
  594.    BUGS
  595.     The 68020++ version of amigancp.library requires the hardware
  596.     to be able to do misaligned word accesses. Some early
  597.     accelerator boards may have problems doing this.
  598.  
  599.    SEE ALSO
  600.  
  601. amigancp.library/NCP_LinkRemoteRun         amigancp.library/NCP_LinkRemoteRun
  602.  
  603.    NAME
  604.    NCP_LinkRemoteRun -- use the NCP link channel to run a program on
  605.                         the remote machine.
  606.  
  607.    SYNOPSIS
  608.    error = NCP_LinkRemoteRun( filename, cmdline, cmdlinelen )
  609.    D0                            A0       A1        D0
  610.  
  611.    LONG NCP_LinkRemoteRun( STRPTR, APTR, ULONG );
  612.  
  613.    FUNCTION
  614.    Use the LINK supervisor channel to have the remote link
  615.    run a program. No NCP channel needs to be opened in order
  616.    to perform this operation.
  617.  
  618.    INPUTS
  619.    filename -- file name of the remote program to start
  620.    cmdline -- pointer to command line array. Note that
  621.               EPOC command lines are *NOT* zero terminated.
  622.    cmdlinelen -- length of command line in bytes. May be
  623.                  zero, in which case no command line
  624.                  is transfered.
  625.  
  626.    RESULT
  627.    error -- either an AmigaNCP specific error code or the
  628.             result code from the remote link.
  629.  
  630.    EXAMPLE
  631.    Have WORD.APP read the Amiga startup sequence:
  632.  
  633.        UBYTE cmdline[] = {
  634.         "OANCPTest\000 V TES\000REM::SYS:\S\STARTUP-SEQUENCE\000"
  635.        };
  636.        error = NCP_LinkRemoteRun( "WORD.APP", cmdline, sizeof( cmdline ) );
  637.  
  638.    NOTES
  639.    See the Psion SDK for more information about using commandlines and
  640.    the LINK process launch feature.
  641.  
  642.    BUGS
  643.    None known.
  644.  
  645.    SEE ALSO
  646.  
  647. amigancp.library/NCP_OpenChannel             amigancp.library/NCP_OpenChannel
  648.  
  649.    NAME
  650.     NCP_OpenChannel -- open a NCP channel to attempt to connect to
  651.                       the remote.
  652.  
  653.    SYNOPSIS
  654.     channel = NCP_OpenChannel( localname, remotename, flags )
  655.       D0                          A0          A1        D0
  656.  
  657.     APTR NCP_OpenChannel( STRPTR, STRPTR, ULONG );
  658.  
  659.    FUNCTION
  660.     Opens an NCP channel. If remotename is not NULL, attempts
  661.     to connect to the remote process and fails with a NULL
  662.     return if the connection could not be made. If remotename
  663.     is NULL, creates a passive channel silently awaiting remote
  664.     connection.
  665.    
  666.    INPUTS
  667.     localname -- name of local "process"
  668.     remotename -- either NULL for a passive channel or
  669.                   the remote process name which to connect
  670.                   to
  671.     flags -- currently unused, leave at 0
  672.  
  673.    RESULT
  674.     channel -- pointer to a channel object. NULL in case of
  675.                an error, whereas additional error information
  676.                can be found in IoErr()
  677.  
  678.    EXAMPLE
  679.     To connect to the remote file server:
  680.  
  681.        APTR channel;
  682.        channel = NCP_OpenChannel( "TestHost", "SYS$RFSV.*", 0 );
  683.  
  684.  
  685.    NOTES
  686.     Opening an active channel will result in an attempt to
  687.     create an NCP connection and fail upon any error (including
  688.     serial failure or inexistance of the remote process).
  689.     Creating an passive channel will not cause an NCP connection
  690.     attempt; this is done upon the first I/O request made to
  691.     channel.
  692.  
  693.    BUGS
  694.     None known.
  695.  
  696.    SEE ALSO
  697.     NCP_CloseChannel()
  698.  
  699. amigancp.library/NCP_Read                           amigancp.library/NCP_Read
  700.  
  701.    NAME
  702.     NCP_Read -- do a read request.
  703.  
  704.    SYNOPSIS
  705.     status = NCP_Read( channel, data, datasize )
  706.       D0                     A0    
  707.  
  708.     LONG NCP_Read( APTR, APTR, ULONG );
  709.  
  710.    FUNCTION
  711.     This is basically identical to calling NCP_BeginRead()
  712.     followed by NCP_WaitRead().
  713.    
  714.    INPUTS
  715.     channel -- a NCP channel created by NCP_OpenChannel()
  716.     data -- receive buffer
  717.     datasize -- receive buffer size
  718.  
  719.    RESULT
  720.     status -- number of bytes read or a negative error
  721.               number.
  722.              
  723.    EXAMPLE
  724.  
  725.    NOTES
  726.  
  727.    BUGS
  728.  
  729.    SEE ALSO
  730.     NCP_WaitRead(), NCP_BeginRead(), NCP_AbortRead(), NCP_CheckRead()
  731.  
  732. amigancp.library/NCP_ReadSig                     amigancp.library/NCP_ReadSig
  733.  
  734.    NAME
  735.     NCP_ReadSig -- return signal mask of channel read port.
  736.  
  737.    SYNOPSIS
  738.     sigmask = NCP_ReadSig( channel )
  739.       D0                     A0    
  740.  
  741.     ULONG NCP_ReadSig( APTR );
  742.  
  743.    FUNCTION
  744.     This function returns the signal mask of the read port
  745.     of the given NCP channel. This signal is set if a read
  746.     request completes.
  747.    
  748.    INPUTS
  749.     channel -- a NCP channel created by NCP_OpenChannel()
  750.  
  751.    RESULT
  752.     sigmask -- signal mask of read port.
  753.              
  754.    EXAMPLE
  755.  
  756.    NOTES
  757.     Note that this function returns a signal mask, not a signal bit number.
  758.  
  759.    BUGS
  760.  
  761.    SEE ALSO
  762.     NCP_BeginRead()
  763.  
  764. amigancp.library/NCP_tab_ibm2iso             amigancp.library/NCP_tab_ibm2iso
  765.  
  766.    NAME
  767.     NCP_tab_ibm2iso -- returns pointer to internal ibm2iso tab
  768.  
  769.    SYNOPSIS
  770.     tab = NCP_tab_ibm2iso()
  771.     D0/A0
  772.  
  773.     UBYTE *NCP_tab_ibm2iso( void );
  774.  
  775.    FUNCTION
  776.     Returns a pointer to the internal ibm2iso conversion table.
  777.     This allows you to do more efficient conversion.
  778.  
  779.    INPUTS
  780.     None.
  781.  
  782.    RESULT
  783.     tab -- pointer to 256 byte conversion table.
  784.  
  785.    EXAMPLE
  786.  
  787.    NOTES
  788.     The pointer is returned both in D0 and A0.
  789.  
  790.    BUGS
  791.     None known.
  792.  
  793.    SEE ALSO
  794.  
  795. amigancp.library/NCP_tab_iso2ibm             amigancp.library/NCP_tab_iso2ibm
  796.  
  797.    NAME
  798.     NCP_tab_iso2ibm -- returns pointer to internal iso2ibm tab
  799.  
  800.    SYNOPSIS
  801.     tab = NCP_tab_iso2ibm()
  802.     D0/A0
  803.  
  804.     UBYTE *NCP_tab_iso2ibm( void );
  805.  
  806.    FUNCTION
  807.     Returns a pointer to the internal ISO2IBM conversion table.
  808.     This allows you to do more efficient conversion.
  809.  
  810.    INPUTS
  811.     None.
  812.  
  813.    RESULT
  814.     tab -- pointer to 256 byte conversion table.
  815.  
  816.    EXAMPLE
  817.  
  818.    NOTES
  819.     The pointer is returned both in D0 and A0.
  820.  
  821.    BUGS
  822.     None known.
  823.  
  824.    SEE ALSO
  825.  
  826. amigancp.library/NCP_WaitRead                   amigancp.library/NCP_WaitRead
  827.  
  828.    NAME
  829.     NCP_WaitRead -- complete a read request on the NCP channel.
  830.  
  831.    SYNOPSIS
  832.     result = NCP_WaitRead( channel )
  833.       D0                     A0    
  834.  
  835.     LONG NCP_WaitRead( APTR );
  836.  
  837.    FUNCTION
  838.     Waits for the current read request to finish and
  839.     returns the result.
  840.    
  841.    INPUTS
  842.     channel -- a NCP channel created by NCP_OpenChannel()
  843.  
  844.    RESULT
  845.     status -- number of bytes read or a negative error
  846.               number.
  847.              
  848.    EXAMPLE
  849.  
  850.    NOTES
  851.     Every read request startet with NCP_BeginRead() absolutely
  852.     must be followed by a NCP_WaitRead(), even if it already
  853.     finished or was aborted via NCP_AbortRead().
  854.  
  855.    BUGS
  856.     Calling this function without an queued read request
  857.     will hang up your process.
  858.  
  859.    SEE ALSO
  860.     NCP_Read(), NCP_BeginRead(), NCP_AbortRead(), NCP_CheckRead()
  861.  
  862. amigancp.library/NCP_WaitWrite                 amigancp.library/NCP_WaitWrite
  863.  
  864.    NAME
  865.     NCP_WaitWrite -- complete a write request on the NCP channel.
  866.  
  867.    SYNOPSIS
  868.     result = NCP_WaitWrite( channel )
  869.       D0                     A0    
  870.  
  871.     LONG NCP_WaitWrite( APTR );
  872.  
  873.    FUNCTION
  874.     Waits for the current write request to finish and
  875.     returns the result.
  876.    
  877.    INPUTS
  878.     channel -- a NCP channel created by NCP_OpenChannel()
  879.  
  880.    RESULT
  881.     status -- number of bytes written or a negative error
  882.               number.
  883.              
  884.    EXAMPLE
  885.  
  886.    NOTES
  887.     Every write request startet with NCP_BeginWrite() absolutely
  888.     must be followed by a NCP_WaitWrite(), even if it already
  889.     finished or was aborted via NCP_AbortWrite().
  890.  
  891.    BUGS
  892.     Calling this function without an queued write request
  893.     will hang up your process.
  894.  
  895.    SEE ALSO
  896.     NCP_Write(), NCP_BeginWrite(), NCP_AbortWrite(), NCP_CheckWrite()
  897.  
  898. amigancp.library/NCP_Write                         amigancp.library/NCP_Write
  899.  
  900.    NAME
  901.     NCP_Write -- do a write request.
  902.  
  903.    SYNOPSIS
  904.     status = NCP_Write( channel, data, datasize )
  905.       D0                   A0     A1      D0
  906.  
  907.     LONG NCP_Write( APTR, APTR, ULONG );
  908.  
  909.    FUNCTION
  910.     This is basically identical to calling NCP_BeginWrite()
  911.     followed by NCP_WaitWrite().
  912.    
  913.    INPUTS
  914.     channel -- a NCP channel created by NCP_OpenChannel()
  915.     data -- receive buffer
  916.     datasize -- receive buffer size
  917.  
  918.    RESULT
  919.     status -- number of bytes written or a negative error
  920.               number.
  921.              
  922.    EXAMPLE
  923.  
  924.    NOTES
  925.  
  926.    BUGS
  927.  
  928.    SEE ALSO
  929.     NCP_WaitWrite(), NCP_BeginWrite(), NCP_AbortWrite(), NCP_CheckWrite()
  930.  
  931. amigancp.library/NCP_WriteSig                   amigancp.library/NCP_WriteSig
  932.  
  933.    NAME
  934.     NCP_WriteSig -- return signal mask of channel write port.
  935.  
  936.    SYNOPSIS
  937.     sigmask = NCP_WriteSig( channel )
  938.       D0                     A0    
  939.  
  940.     ULONG NCP_WriteSig( APTR );
  941.  
  942.    FUNCTION
  943.     This function returns the signal mask of the write port
  944.     of the given NCP channel. This signal is set if a write
  945.     request completes.
  946.    
  947.    INPUTS
  948.     channel -- a NCP channel created by NCP_OpenChannel()
  949.  
  950.    RESULT
  951.     sigmask -- signal mask of write port.
  952.              
  953.    EXAMPLE
  954.  
  955.    NOTES
  956.     Note that this function returns a signal mask, not a signal bit number.
  957.  
  958.    BUGS
  959.  
  960.    SEE ALSO
  961.     NCP_BeginWrite()
  962.  
  963.